Skip to content

POC: Code PyGMT logo in PyGMT #3849

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 210 commits into
base: main
Choose a base branch
from
Draft

POC: Code PyGMT logo in PyGMT #3849

wants to merge 210 commits into from
+488 −0

Conversation

@yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Mar 13, 2025 •
edited
Loading

Description of proposed changes

Related to #1404 (comment), create the PyGMT logo in Python with PyGMT.

  • Python script
  • Separat method Figure.pygmtlogo or Figure.logo_pygmt as part of the Figure class or addition to the method Figure.logo (which plots the GMT logo)
  • Gallery example

Preview:

Related to

TODO:

  • Update intro comment of this PR
  • Remove temporary files (eps)
  • Include adding a wordmark and it's orientation to the input at the beginning
  • Update codes to finale version of the visual
  • Introduce variables
  • Improve parameter names, e.g., shape="circle" | "hexagon" or hex=False | True
  • Convert to function (remove show and rdeuce save to tempoary eps files, replot via Figure.image)
  • Remove saving as eps file for rotation (first get ride of transparent margin)
  • Remove saving as eps file for adding wordmark (different basemaps due to horizontal and vertical orientation)
  • Convert to a method of the Figure class or addition to Figure.logo.
  • Add or expand gallery example to use the method
  • Explain the story behind the logo in the gallery example

Issues:

  • Get ride of white or transparent margin
  • Currently the rotation and adding the wordmark are done in new Figure objects using the saved eps files. Maybe this is not easy to handle when converting to a method of the Figure classe.
  • Decide about font for the wordmark (font Space Grotesk by Florian Karsten not available in GMT)
  • No direct export to SVG format possible
  • etc.

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash command is:

  • /format: automatically format and lint the code

@yvonnefroehlich yvonnefroehlich added the documentation Improvements or additions to documentation label Mar 13, 2025
@yvonnefroehlich yvonnefroehlich self-assigned this Mar 13, 2025
@yvonnefroehlich yvonnefroehlich changed the title Add first version of PyGMT code for PyGMT logo POC: DOC: Code PyGMT logo in PyGMT and add as gallery example Mar 13, 2025
@yvonnefroehlich
Copy link
Member Author

/format

@michaelgrund
Copy link
Member

michaelgrund commented Mar 13, 2025 •
edited
Loading

I feel the logo definition should be separated into a standalone method, similar to the method to plot the GMT logo. This would allow to plot the PyGMT logo by calling something like pygmt.Figure.pygmt_logo. The individual formats could be selected by different input parameters like you did or hex = True or darkmode = True.

michaelgrund
michaelgrund reviewed Mar 13, 2025
View reviewed changes
yvonnefroehlich
yvonnefroehlich commented Mar 13, 2025
View reviewed changes
@yvonnefroehlich yvonnefroehlich marked this pull request as draft March 13, 2025 13:27
@yvonnefroehlich yvonnefroehlich changed the title POC: DOC: Code PyGMT logo in PyGMT and add as gallery example POC: DOC: Code PyGMT logo in PyGMT (method Figure.pygmt_logo and gallery example) Mar 13, 2025
@yvonnefroehlich yvonnefroehlich added the feature Brand new feature label Mar 13, 2025
@yvonnefroehlich yvonnefroehlich changed the title POC: DOC: Code PyGMT logo in PyGMT (method Figure.pygmt_logo and gallery example) POC: Code PyGMT logo in PyGMT (method Figure.pygmt_logo and gallery example) Mar 13, 2025
@yvonnefroehlich yvonnefroehlich changed the title POC: Code PyGMT logo in PyGMT (method Figure.pygmt_logo and gallery example) POC: Code PyGMT logo in PyGMT (method or / and gallery example) Mar 13, 2025
@yvonnefroehlich
Copy link
Member Author

ruff v0.10.0 was released 2 hours ago causing the newly falling code style checks.

@weiji14 weiji14 mentioned this pull request Mar 13, 2025
Merged
6 tasks
@yvonnefroehlich yvonnefroehlich mentioned this pull request Mar 13, 2025
Open
weiji14
weiji14 reviewed Mar 13, 2025
View reviewed changes
yvonnefroehlich
yvonnefroehlich commented Mar 13, 2025
View reviewed changes
seisman
seisman reviewed Jul 24, 2025
View reviewed changes
seisman
seisman reviewed Jul 26, 2025
View reviewed changes
seisman
seisman reviewed Jul 26, 2025
View reviewed changes
yvonnefroehlich
yvonnefroehlich commented Sep 4, 2025
View reviewed changes
pygmt/src/pygmtlogo.py
Comment on lines +31 to +35
wordmark : bool, str
Add the wordmark "PyGMT" and adjust its orientation relative to the visual. Set
to ``True`` or ``"horizontal"``, to add the wordmark at the right side of the
visual [Default]. Use ``"vertical"`` to place the wordmark below the visual
and ``False`` to add no wordmark.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am wondering if we want to have the option to add the URL to the PyGMT website, similar as for the GMT logo?

seisman
seisman reviewed Oct 24, 2025
View reviewed changes
pygmt/src/pygmtlogo.py
Comment on lines +93 to +106
fig = pygmt.Figure()

# blue circle / hexagon for Earth
fig.plot(
x=0,
y=0,
region=region,
projection=projection,
style=f"{symbol}{diameter}c",
pen=f"0.5c,{color_blue}",
fill=color_bg,
perspective=perspective,
no_clip=True, # needed for corners of hexagon shape
)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find it's more convenient to debug and tweak the logo with a frame and gridlines. Here, frame="+n" means not to plot the frame. When debugging, just change it to frame="afg".

Suggested change
fig = pygmt.Figure()
# blue circle / hexagon for Earth
fig.plot(
x=0,
y=0,
region=region,
projection=projection,
style=f"{symbol}{diameter}c",
pen=f"0.5c,{color_blue}",
fill=color_bg,
perspective=perspective,
no_clip=True, # needed for corners of hexagon shape
)
fig = pygmt.Figure()
fig.basemap(
region=region,
projection=projection,
perspective=perspective,
frame="+n", # Change it to `frame="afg"` for debugging.
)
# blue circle / hexagon for Earth
fig.plot(
x=0,
y=0,
style=f"{symbol}{diameter}c",
pen=f"0.5c,{color_blue}",
fill=color_bg,
perspective=True,
no_clip=True, # needed for corners of hexagon shape
)

pygmt/src/pygmtlogo.py
lines_compass = [
([-r0, -r2], [0, 0]), # horizontal lines
([-r4, 0], [0, 0]),
([r2, r0], [0, 0]),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
([r2, r0], [0, 0]),
([r2, r0], [0, 0]),
([0, 0], [-r0, r0]), # vertical line

pygmt/src/pygmtlogo.py
perspective=True,
)
# arrow tail
fig.plot(x=[0, 0], y=[-2, -3.57], pen=f"12p,{color_red}", perspective=True)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
fig.plot(x=[0, 0], y=[-2, -3.57], pen=f"12p,{color_red}", perspective=True)
fig.plot(x=[0, 0], y=[-2, -3.57], pen=f"12p,{color_red}", perspective=True)
# Extra vertical compass line above letters "G" and "M".
fig.plot(x=[0, 0], y=[-r4 * 0.9, r2], pen=f"5p,{color_yellow}", perspective=True)

seisman
seisman reviewed Oct 24, 2025
View reviewed changes
pygmt/src/pygmtlogo.py
Comment on lines +137 to +140
# space between red line and blue circle / hexagon
fig.plot(x=[0, 0], y=[4, 3.0], pen=f"18p,{color_bg}", perspective=True)
# red line
fig.plot(x=[0, 0], y=[4, 1.9], pen=f"12p,{color_red}", perspective=True)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# space between red line and blue circle / hexagon
fig.plot(x=[0, 0], y=[4, 3.0], pen=f"18p,{color_bg}", perspective=True)
# red line
fig.plot(x=[0, 0], y=[4, 1.9], pen=f"12p,{color_red}", perspective=True)
# space between red line and blue circle / hexagon
fig.plot(x=[0, 0], y=[r0, r2], pen=f"18p,{color_bg}", perspective=True)
# red line
fig.plot(x=[0, 0], y=[r0, r2], pen=f"12p,{color_red}", perspective=True)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@seisman seisman seisman left review comments

@michaelgrund michaelgrund michaelgrund left review comments

@weiji14 weiji14 weiji14 left review comments

At least 1 approving review is required to merge this pull request.

Assignees

@yvonnefroehlich yvonnefroehlich

Labels

documentation Improvements or additions to documentation feature Brand new feature

Projects

PyGMT paper
Status: No status

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@yvonnefroehlich @michaelgrund @seisman @weiji14